<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UDisks2.Filesystem.BTRFS: UDisks Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ch02.html" title="D-Bus Interfaces">
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.Manager.BTRFS.html" title="org.freedesktop.UDisks2.Manager.BTRFS">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Manager.ZRAM.html" title="org.freedesktop.UDisks2.Manager.ZRAM">
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Manager.BTRFS.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Manager.ZRAM.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Filesystem-BTRFS.top_of_page"></a>org.freedesktop.UDisks2.Filesystem.BTRFS</span></h2>
<p>org.freedesktop.UDisks2.Filesystem.BTRFS — BTRFS filesystem interface exported on block objects</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.AddDevice" title="The AddDevice() method">AddDevice</a>       (IN  o      device,
                 IN  a{sv}  options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.RemoveDevice" title="The RemoveDevice() method">RemoveDevice</a>    (IN  o      device,
                 IN  a{sv}  options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.CreateSubvolume" title="The CreateSubvolume() method">CreateSubvolume</a> (IN  s      name,
                 IN  a{sv}  options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.RemoveSubvolume" title="The RemoveSubvolume() method">RemoveSubvolume</a> (IN  s      name,
                 IN  a{sv}  options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.GetSubvolumes" title="The GetSubvolumes() method">GetSubvolumes</a>   (IN  b      snapshots_only,
                 IN  a{sv}  options,
                 OUT a(tts) subvolumes,
                 OUT i      subvolumes_cnt);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.CreateSnapshot" title="The CreateSnapshot() method">CreateSnapshot</a>  (IN  s      source,
                 IN  s      dest,
                 IN  b      ro,
                 IN  a{sv}  options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.Repair" title="The Repair() method">Repair</a>          (IN  a{sv}  options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.Resize" title="The Resize() method">Resize</a>          (IN  t      size,
                 IN  a{sv}  options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.SetLabel" title="The SetLabel() method">SetLabel</a>        (IN  s      label,
                 IN  a{sv}  options);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.25.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.label" title='The "label" property'>label</a>        readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.uuid" title='The "uuid" property'>uuid</a>         readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.num_devices" title='The "num_devices" property'>num_devices</a>  readable   t
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.used" title='The "used" property'>used</a>         readable   t
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-Filesystem-BTRFS"></a><h2>Description</h2>
<p>      This interface is used for #org.freedesktop.UDisks2.Block devices that
      has been filtered through BTRFS plugin.
</p>
<p class="since">Since 2.1.3</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.Filesystem.BTRFS"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.AddDevice"></a><h3>The AddDevice() method</h3>
<pre class="programlisting">
AddDevice (IN  o     device,
           IN  a{sv} options);
</pre>
<p>        Adds the <em class="parameter"><code>device</code></em> to the volume.
</p>
<p>        No additional options are currently defined.
</p>
<p>        <span class="emphasis"><em>Changed in version 2.7.0.</em></span>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>device</code></em></code>:</span></p></td>
<td><p>Object path of a device to be added to BTRFS volume.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Additional options.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.RemoveDevice"></a><h3>The RemoveDevice() method</h3>
<pre class="programlisting">
RemoveDevice (IN  o     device,
              IN  a{sv} options);
</pre>
<p>        Removes the <em class="parameter"><code>device</code></em> from the volume.
</p>
<p>        No additional options are currently defined.
</p>
<p>        <span class="emphasis"><em>Changed in version 2.7.0.</em></span>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>device</code></em></code>:</span></p></td>
<td><p>Object path of a device to be removed from BTRFS volume.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Additional options.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.CreateSubvolume"></a><h3>The CreateSubvolume() method</h3>
<pre class="programlisting">
CreateSubvolume (IN  s     name,
                 IN  a{sv} options);
</pre>
<p>        Creates a new subvolume.
</p>
<p>        No additional options are currently defined.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
<td><p>Name of a new subvolume.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Additional options.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.RemoveSubvolume"></a><h3>The RemoveSubvolume() method</h3>
<pre class="programlisting">
RemoveSubvolume (IN  s     name,
                 IN  a{sv} options);
</pre>
<p>        Deletes a subvolume.
</p>
<p>        No additional options are currently defined.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
<td><p>Name of the subvolume to be deleted.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Additional options.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.GetSubvolumes"></a><h3>The GetSubvolumes() method</h3>
<pre class="programlisting">
GetSubvolumes (IN  b      snapshots_only,
               IN  a{sv}  options,
               OUT a(tts) subvolumes,
               OUT i      subvolumes_cnt);
</pre>
<p>        Returns a list of subvolumes.
</p>
<p>        No additional options are currently defined.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>snapshots_only</code></em></code>:</span></p></td>
<td><p>True if to list only snapshot subvolumes; False otherwise.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Additional options.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT a(tts) <em class="parameter"><code>subvolumes</code></em></code>:</span></p></td>
<td><p>Structure containing subvolume id, parent_id and path.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT i <em class="parameter"><code>subvolumes_cnt</code></em></code>:</span></p></td>
<td><p>The number of returned elements.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.CreateSnapshot"></a><h3>The CreateSnapshot() method</h3>
<pre class="programlisting">
CreateSnapshot (IN  s     source,
                IN  s     dest,
                IN  b     ro,
                IN  a{sv} options);
</pre>
<p>        Creates a snapshot.
</p>
<p>        No additional options are currently defined.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>source</code></em></code>:</span></p></td>
<td><p>Name of the source subvolume.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>dest</code></em></code>:</span></p></td>
<td><p>Name for the new snapshot volume.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>ro</code></em></code>:</span></p></td>
<td><p>True if the snapshot should be read-only; False otherwise.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Additional options.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.Repair"></a><h3>The Repair() method</h3>
<pre class="programlisting">
Repair (IN  a{sv} options);
</pre>
<p>        Checks and repairs btrfs volume.
</p>
<p>        No additional options are currently defined.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Additional options.</p></td>
</tr></tbody>
</table></div>
<p class="since">Since 2.3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.Resize"></a><h3>The Resize() method</h3>
<pre class="programlisting">
Resize (IN  t     size,
        IN  a{sv} options);
</pre>
<p>        Resizes the volume.
</p>
<p>        No additional options are currently defined.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td><p>Requested new size in Bytes.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Additional options.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.SetLabel"></a><h3>The SetLabel() method</h3>
<pre class="programlisting">
SetLabel (IN  s     label,
          IN  a{sv} options);
</pre>
<p>        Sets a new label for the given volume.
</p>
<p>        No additional options are currently defined.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>label</code></em></code>:</span></p></td>
<td><p>New label.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Additional options.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.1.3</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.Filesystem.BTRFS"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.label"></a><h3>The "label" property</h3>
<pre class="programlisting">
label  readable   s
</pre>
<p></p>
<p class="since">Since 2.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.uuid"></a><h3>The "uuid" property</h3>
<pre class="programlisting">
uuid  readable   s
</pre>
<p></p>
<p class="since">Since 2.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.num_devices"></a><h3>The "num_devices" property</h3>
<pre class="programlisting">
num_devices  readable   t
</pre>
<p></p>
<p class="since">Since 2.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.used"></a><h3>The "used" property</h3>
<pre class="programlisting">
used  readable   t
</pre>
<p></p>
<p class="since">Since 2.1.3</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>